home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Shareware Grab Bag
/
Shareware Grab Bag.iso
/
002
/
filecat.arc
/
FILECAT.DOC
< prev
next >
Wrap
Text File
|
1986-03-05
|
46KB
|
923 lines
USERS MANUAL
---------------------------------
FILECAT.COM
---------------------------------
A File Cataloging Utility
written by Kenn Flee
of
Jamestown Software
for the
Madison WI IBM-PC USERS GROUP
(Turbo Pascal SIG)
Version 2.1
March 2, 1986
The Madison IBM-PC User's Group, Turbo Pascal SIG, Jamestown
Software and/or Kenn Flee will not be liable for any damages,
including any lost profits, lost savings or other incidental
or consequential damages arising out of the use of or inabil-
ity to use FILECAT.COM, even if the GROUP or Jamestown Soft-
ware has been advised of the possibility of such damages, or
for any claim by any other party.
FILECAT.COM is hereby released into the PUBLIC DOMAIN.
Page 1
INTRODUCTION:
This program was written in response to a request by our
Turbo Pascal SIG Librarian. We had a problem with our
library disks that many other users have experienced... too
many files on too many disks. What is on each disk? How can
we find a particular file? How are the various files
related? As we expect our library to grow rapidly, we
decided to try to solve the problem before it really got out
of hand.
Of course, the problem of too many files scattered all over
the place is a familiar one to hard disk users and active
programmer types. I certainly have little files on a bunch
of floppies and in various subdirectories all over my hard
disk. Now, I'm not by nature a particularly disorganized
person, but I AM active on the local BBS's (downloading
everything that looks interesting) and have lots of little
Pascal files that I'm sure I wrote for SOME reason. Anyway,
there appears to be a need for an easy-to-use file cataloging
utility for use by User Group Librarians, BBS Sysops, AND
everyday users. FILECAT is in response to that need.
FEATURES:
* Written in Turbo Pascal (source code available).
* ISAM database with B+Tree structure.
* For floppy or harddisk systems.
* Menu-driven for ease of use.
* Allows entry of KEYWORDS with keyword search and sort.
* Library of 700+ common keywords may be accessed.
* Allows entry of Main File designation and Associated
File identification. Searches, sorts and prints listings
of "families" of files.
* Allows creation of a "transfer file" to be included on
user group library disks. Senses existence of such a file
and allows automatic transfer of the data into the master
database file.
* Allows file descriptions of over 300 characters.
* Automatically includes harddisk path and floppy volume name
location identifiers.
* Epson printer setup utility.
* Add, search, sort, edit and delete functions with duplicate
filenames identified, but allowed.
* Database file size limited only by floppy disk/hard disk
size, or 32,760 records, whichever comes first.
* Released into the public domain for everyone's use and
(hopefully) a standard to be included on all user group
library disks.
Page 2
FILES INCLUDED:
Just four: FILECAT.COM The program file.
FILECAT.000 An overlay file.
FILECAT.KWD A library of Keywords.
FILECAT.DOC This users manual.
The program will create additional files as needed:
FILECAT.DAT The database main data file.
FILECAT.IXN The database main index file.
TRANSFER.DAT Either a temporary data file
(when on the disk where FILECAT.COM
resides) or a transfer file (when
on the source disk).
TRANSFER.DXT A transfer file that has been read
into the main database and renamed
by FILECAT from TRANSFER.DAT.
TRANSFER.IXN A temporary index file.
INSTALLATION:
Floppy Disk Users: Put original disk in drive A.
Put blank, formatted disk in drive B.
Copy FILECAT.COM (Copy A:FILECAT.COM B:).
Copy FILECAT.000 (Copy A:FILECAT.000 B:).
Copy FILECAT.KWD (Copy A:FILECAT.KWD B:).
Hard Disk Users: Make a subdirectory (MD \FILECAT).
Change subdirectories (CD \FILECAT).
Place original disk in drive A.
Copy FILECAT files into subdirectory.
(Copy A:\FILECAT.*).
FILECAT will sense the existence of both CGA color cards
and monochrome cards and adjust itself accordingly. On color
cards driving some composite video monochrome monitors, you
may wish to press '8' in the Main Menu to toggle between
color mode and black and white mode.
RUNNING FILECAT:
Floppy Disk Users: Be sure you see the "A>" prompt! If you
don't, type A: and return. Place your
FILECAT working disk in drive A. Place
your source disk (the one you are going
to get file information from) in drive B.
Type "FILECAT" and return.
Page 3
RUNNING FILECAT (continued):
Hard Disk Users: IMPORTANT: ALWAYS run FILECAT from the
subdirectory in which it resides! (If you
don't, the program will get mad at you and
keep asking you to put the disk back in.)
Sooo... Change into the FILECAT subdirectory
(CD \FILECAT). Place either a formatted
disk or your source disk in drive A: (If
you don't, FILECAT will complain a little
bit, but no real damage will be done... it
will just be a bit annoying.) Type
"FILECAT" and return.
The first time you run FILECAT, it will create the
FILECAT.DAT data file and FILECAT.IXN index file. A brief
message will appear at the bottom of the screen.
THE "TRANSFER FILE FOUND..." MESSAGE:
If your source disk (maybe a User Group Library disk) has had
a Transfer File stored on it, FILECAT will display the
following message:
"TRANSFER file found on Source Directory... Add to database?"
Press "Y" to add the information contained in the transfer
file to your database, or "N" if not. I suggest you answer
"Y", 'cause the program is just going to keep asking you at
regular intervals if you want to do it, so you may as well
get it over with. When you answer "Y", FILECAT will read the
information from the source file, change the "TRANSFER.DAT"
name to "TRANSFER.DXT", and stop bothering you.
THE "PLACE THE FILECAT.COM DISK IN..." MESSAGE:
If you get this message, you either ran FILECAT with a DOS
Prompt different from the disk or subdirectory that FILECAT
resides in, or (floppy disk users) you removed the FILECAT
disk or opened the disk drive door. Reread the "RUNNING
FILECAT" instructions above.
Page 4
THE MAIN MENU:
After you get past the previous two messages, you will see
the Main Menu. At the top of the screen are the FILECAT
drive/directory, the source drive/directory, the diskette
volume name (if source disk is on drive A: or B:) and the DOS
version you are running. (If you aren't using DOS2.x or
greater you never got this far... the program kicked you
out!) At the bottom left is the number of bytes left on your
FILECAT drive/directory. If there are less than 2000 bytes
left, you will get a flashing warning.
There are 8 choices listed in the main menu as follows:
1 -- CHANGE Source Drive/Directory
2 -- ENTER New File Data
3 -- SEARCH Database for KEYWORD MATCH
4 -- BROWSE/EDIT DataBase Records
5 -- REPORTS and UTILITIES
7 -- Set Epson Print Codes
8 -- Change Color
9 -- End
To select, press the number of the choice desired. Each
choice is described below.
CHANGE SOURCE DRIVE/DIRECTORY (Main Menu Choice 1):
Identify your source drive (floppies) or directory path (hard
disk). FILECAT will attempt to change to the identified
source drive/directory. If there is a problem FILECAT will
revert to the previous identified source drive/directory.
HINT: If you're not entering new data, either put a formatted
disk in the source drive or change the source drive to
be the same as the FILECAT drive.
ENTER NEW FILE DATA (Main Menu Choice 2):
Before selecting Choice 2, be sure you have the proper source
drive/directory identified (Choice 1), and your desired disk
in that drive. If your source drive is A: or B: FILECAT will
attempt to read the volume name of the diskette. If there is
no volume name, you will be required to enter a temporary
volume name identifier.
Page 5
ENTER NEW FILE DATA (continued):
The data entry screen will be displayed. In a window at the
right is a list of files on your source disk. You now have
two options. You may press the F1 function key to enter ALL
files into the database or, using the cursor keys, you may
select the individual file you wish to add to the database
(press return). If the file has already been entered, the
old file data will be displayed and you have the option to
delete the old entry or add the selected file. If the
selected file is a new file, the window will disappear and
the file information displayed at the top of the screen.
If you elected to add ALL files, you will be returned to the
main menu (You may add keywords and descriptions by pressing
"4" and editing the desired entries). If you selected an
individual file you may now add the following information:
Stand Alone? This question is one that our Turbo SIG group
found useful and if you understand its intent,
perhaps you can use it your situation. (If you
don't understand this question, or have no need
for it, just press "Y"). The problem with
Turbo Pascal programs (and others, actually) is
that large applications tend to have a bunch of
"include", "overlay", and "chain" files
associated with them. In other words, you need
more than just the one source file to make the
program go. So that we don't break up these
"families" of associated files, this question
allows you to define a group of associated
files that help keep everything connected
together. Anyway, if this file does not
require other files to work, answer this
question "Y", but if other files ARE required,
answer "N" (No, this file does NOT stand alone,
but requires other files to work).
------------------------------------------------------------
If you answered "N" to the question above, you will be asked:
Main File Name: Enter the file name (not extension) of the
Main or Primary File associated with this
file. If this file IS the primary file,
REPEAT the filename of this file.
Extension: The extension of the file entered in main
file name above.
------------------------------------------------------------
Page 6
ENTER NEW FILE DATA (continued):
Keywords: Enter some keywords for this file. Try to
establish some consistency with your keywords...
for instance GRAPHICS for all graphic files or
UTILITY for all utility files (See NOTE below).
Maybe an author name for some favorite downloaded
programs. You may enter one line of keywords,
separating each keyword with a space. Later you
can search for a keyword and quickly retrieve
files of similiar types. Compuserve users are
familiar with this type of keyword search, and
once you see the power in the use of keywords,
you'll wonder how you ever got along without them.
Since you have a full line to work with, you may
as well fill it up.
NOTE: By pressing the F1 function key, a library
of over 700 common keywords will be displayed.
Use the cursor keys until your choice is
highlighted, then press Enter. Your selection
will be added to those already on the Keyword
line. Any NEW keywords you enter will
automatically be added to the library.
HINT: If you wish to save disk space so more file
information may be stored, do NOT copy the
FILECAT.KWD file from your distribution disk.
FILECAT will then create a Keyword library of ONLY
those keywords YOU enter.
Description: Enter up to four lines of descriptive
information about this file. The space is
allocated, so you use it all if you can.
Experiment a little with the cursor keys. HOME and END will
move you to the beginning or end of the line. RIGHT and LEFT
move right and left. UP and DOWN go to the previous or next
field. Insert mode (not overwrite) is always active, so
delete, then insert. BACKSPACE deletes the character to the
left of the cursor, DELETE deletes the character under the
cursor. The INSERT key inserts a space, moving the rest of
the line to the right. If FCD (First Char. Delete) is active
and you type a character in the first position when there is
already text in the field, the field will be blanked. (The
use of the CURSOR RIGHT key toggles this feature OFF for one
field when FCD is active. <F8> toggles FCD on/off. "FCD" is
displayed in lower right of screen when FCD is active.)
When you are done, press the F10 function key. You will
first be asked if you wish to add this record to the database
("Y" to add it, "N" to throw it away), then you will be asked
if you wish another entry from this disk/directory ("Y" to do
another, "N" to return to the Main Menu.
Page 7
SEARCH DATABASE FOR KEYWORD MATCH (Choice 3 in Main Menu):
You will be asked to enter the KEYWORD you wish to search
for. Then you will be given the choice of searching for
EXACT matches (full words ONLY that match your search
keyword), or PARTIAL matches (words that have your search
keyword in them).
As an example, if your search keyword was "DIR", Partial
matches would find "DIR", "DIRECTORY", "SUBDIRECTORY" and
"ROOTDIRECTORY" but Exact match wouldn't find anything but
"DIR".
If a match is found, it will be displayed and you may press:
N or C -- Continue the search
D -- Delete the record
E -- Edit the record
* -- Print the record
Q -- Quit and return to Main Menu
If you continue to search to the end of the file, you will
get the number of matches found.
BROWSE/EDIT DATABASE RECORDS (Choice 4 in Main Menu):
You will be asked to identify the file name to search for.
If you want to start at the beginning of the file, just press
return. (The files will always be displayed -- in all
functions -- in alphabetical order by filename). When any
file is displayed, you may press:
N -- Display next record
P -- Display previous record
S -- Enter new search filename
D -- Delete the record
E -- Edit the record
* -- Print the record
Q -- Quit and return to Main Menu
NOTE: In the case of APPARENT duplicate entries, check the
record number displayed in the right corner of the
screen BEFORE deleting the record. They may look the
same, but they are actually different.
When a Main File is displayed (File Name and Main File Name
are identical) you may press "A" to locate and display all
Associated Files (those with the same Main File Name) in
alphabetical order. To return to normal browsing after
viewing associated files, press "S" and enter a new file name
to search for.
Page 8
REPORTS AND UTILITIES (Choice 5 in Main Menu):
Use to print predefined reports, or to create/close a
transfer file. (See page 8 following for complete
description).
SET EPSON PRINT CODES (Choice 7 in Main Menu):
Use to set print size and left margin on Epson FX/MX/RX and
code-compatible printers.
CHANGE COLOR (Choice 8 in Main Menu):
Each time you press "8" in the Main Menu (if you have a color
display adapter) the screen color will toggle between color
and black/white mode. This feature was added to try to
resolve some display difficulties with monochrome monitors
hooked to color cards. If you have display problems, try
this to see if it helps.
END (Choice 9 in Main Menu):
To end FILECAT and return to DOS. If you are working on a
Transfer File, and have not yet moved it to the source
directory, you will be given ONE LAST CHANCE to save the file
before FILECAT throws it away forever.
------------------------------------------------------------
REPORTS AND UTILITIES MENU:
You may select any of 5 different printed reports from the
Reports and Utilities Menu as described below. You should
set your printer type style and left margin before selecting
your first printed listing. DON'T set an automatic page
length, because FILECAT automatically spaces over the perf
(assuming a 11" page length).
LISTING OF KEYWORDS AND RELATED FILES
(Choice 1 in Reports Menu)):
This choice will scan your database for all keywords, then
print the keywords in alphabetical order, with all files
related to each keyword listed underneath.
Page 9
REPORTS AND UTILITIES MENU (continued):
ALPHABETICAL LIST OF ALL FILES
(Choice 2 in Reports Menu):
This choice will print all the information entered for each
record in your database, in alphabetical order by file name.
LISTING OF DISKS AND RELATED FILES
(Choice 3 in Reports Menu):
This will sort the database into Disk/Directory alphabetical
order, then print a listing of all Disks and/or
Directory/SubDirectories, with all files in each
Disk/Directory listed under the Disk/Directory name.
LISTING OF MAIN/ASSOCIATED FILES
(Choice 4 in Reports Menu):
This will scan the database for all entries identified as NOT
stand alone, then read the Main File Name for those files.
The located entries will be sorted into alphabetical order
and printed with all related files listed under each main
file name.
FILES LISTED ALPHABETICALLY BY EXTENSION
(Choice 5 in Reports Menu):
This choice will print all file names, sorted and grouped by
extension.
TRANSFER FILES:
A Transfer File may be created and stored on a diskette to be
read into another FILECAT database at a later time by someone
else. Each time the source diskette is changed, FILECAT
checks for the existence of a Transfer File and, if found,
allows the data to automatically be transfered into the current
FILECAT database. This feature is intended primarily for
user group librarians for the convenience of those who
acquire the library disks and wish to include the file
descriptions in their master FILECAT database.
Page 10
TRANSFER FILES (continued):
To create a Transfer File, select choice 6 in the Reports
Menu (CREATE and WRITE to Transfer File). You will be
returned to Main Menu. A flashing message in the lower right
corner will remind you that you are now working on a transfer
file. What has happened is that the normal FILECAT.DAT and
FILECAT.IXN data and index files have been replaced by
temporary TRANSFER.DAT and TRANSFER.IXN data and index files.
Everything will work as before. Insert your library diskette
and build a database for all files. When complete, return to
the Reports and Utilities Menu. Note that choice 6 now reads
"MOVE Transfer File to Current Source Drive". If you are
ready to move the file, select choice 6. The program will
confirm that you really do wish to move the file and if so,
copy it to the source disk. When complete, you will be given
the opportunity to ADD the data to your master database.
NOTE: The TRANSFER.DAT file is in the same format as a normal
FILECAT.DAT data file, but without an index file and
with deleted record space removed. Alternately you
could simply create a normal FILECAT.DAT data file,
then copy it (without the FILECAT.IXN index file) to
the library disk, renaming it to TRANSFER.DAT. There
is the possibility that a file created in this manner
would be larger (because of deleted records that were
not reused) and might not actually be the data file you
intended.
If you attempt to exit FILECAT with an open Transfer File,
you will be warned and given another chance to move it to
your source disk. If you choose NOT to move the file now,
the next time you run FILECAT the Transfer File will still
be open, and the flashing "Working on a Transfer File"
displayed at the bottom of your screen. You MUST eventually
move the file in order to return to your normal FILECAT data
file.
HINT: To create a Transfer File on a library disk, first
create it ("5" in main menu, followed by "6" in
utilities menu). Then "2" (Enter File Data), followed
by "F1" (Enter ALL files). Now select "4" (Browse),
edit in Keywords and Descriptions for active files and
delete unwanted files. Finally, move the Transfer File
to the source disk as described above. Note that you
may leave the program to take a break and when you
rerun FILECAT, the Transfer File will still be active.
Page 11
TECHNICAL INFORMATION:
If you wish to try to access the FILECAT.DAT data file, the
following describes the record definition. NOTE: actual data
begins in record 1 (record 0 is reserved for program use).
Status : Integer { 0=Active All Else=Deleted }
FileName : String[12] { File Name padded with spaces at
end + '.' + Extension }
FileTime : Integer { Image of DTA file creation time }
FileDate : Integer { Image of DTA file date }
FileSize : Array[1..4] of Byte { Image of DTA file size }
Floppy : Boolean { True=Floppy False=Hard Disk }
Vol/Path : String[64] { Disk volume name or Hard Disk
Directory Path }
StandAlone : Boolean { True=Stand Alone False=if not }
MainName : String[12] { Main File Name formatted as
FileName above }
Keys : String[79] { Keywords }
Description : Array[1..4] of String[79]
{ Four lines of description }
Each record is 503 bytes in length with 1 record overhead.
Each index key is 14 bytes in length. FILECAT.COM is written
in Turbo Pascal using the Database Toolkit, both by Borland
International. Requires DOS2.x or greater. Written on an
IBM-PC with a color monitor, but should run on close
compatibles with monochrome monitors. Probably should have
256K for reasonably fast processing (program uses as much
normal memory as available for sorting and B+Tree storage,
with disk used for overflow).
SOURCE CODE:
Source code is available to librarians, sysops and other
interested users. However, if this program is to become any
kind of standard for library disks, programmers shouldn't
mess around with the basic record definition so that the
TRANSFER.DAT file may be transported from one group to
another. If you wish to receive a disk with the source code,
librarians should send a couple of their library disks in
trade, while others should send a formatted disk and postpaid
return mailer.